Skip to content

#10670: Add AGENTS.md for AI coding assistant guidance - #815

Open
chetankh239 wants to merge 3 commits into
mosip:developfrom
chetankh239:agents-md-doc
Open

#10670: Add AGENTS.md for AI coding assistant guidance#815
chetankh239 wants to merge 3 commits into
mosip:developfrom
chetankh239:agents-md-doc

Conversation

@chetankh239

@chetankh239 chetankh239 commented Aug 7, 2026

Copy link
Copy Markdown

Addresses mosip/mosip-config#10670 — provides repository overview, tech stack, build/test commands, and contribution notes for AI agents and contributors working in this repo.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive repository guidance covering project structure, technology stack, development workflows, build and test commands, configuration, integrations, and contribution practices.
    • Added Android-specific documentation covering project layout, build workflows, versioning, synchronization, and CI guidance.
    • Added Helm chart documentation covering deployment, configuration, validation, publishing, version alignment, and operational safeguards.

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@chetankh239, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 47 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: e1bb220b-fff2-4e55-9fd1-3415512b94a4

📥 Commits

Reviewing files that changed from the base of the PR and between ce80024 and 996ca58.

📒 Files selected for processing (2)
  • android/AGENTS.md
  • helm/AGENTS.md

Walkthrough

Added repository, Android, and Helm AGENTS.md files. The documents describe architecture, development commands, configuration, CI workflows, Android synchronization, Helm deployment, validation, and repository-specific constraints.

Changes

Repository Guidance

Layer / File(s) Summary
Frontend repository guidance
AGENTS.md
Documents the frontend architecture, technology stack, development commands, configuration, source layout, CI workflows, contribution practices, and implementation constraints.
Android project guidance
android/AGENTS.md
Documents Android project structure, build commands, CI behavior, versioning, synchronization requirements, generated files, and credential handling.
Helm deployment guidance
helm/AGENTS.md
Documents chart structure, deployment and validation commands, CI publishing, configuration requirements, version coordination, and deletion safeguards.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

  • mosip/mosip-labs#74 — Requests repository-specific agent guidance for the frontend, Android, and Helm components.

Poem

Guides mark each path,
Builds, charts, and Android align,
Secrets remain still.
Commands line the way,
Clear notes guard every step.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding AGENTS.md guidance for AI coding assistants.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 66-69: Update .gitignore to exclude the local .env file, and add
or maintain a .env.example containing non-sensitive placeholders for the
documented Android IAM variables. Keep the example free of real credentials and
align its keys with the local setup described in AGENTS.md.
- Line 17: Align the Angular CLI version documented alongside the Angular
versions with the version installed by the Android CI workflow, or update both
references to the intended shared version; if the versions must differ,
explicitly document that split.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4a313b89-f62c-4204-97df-03091f9639c8

📥 Commits

Reviewing files that changed from the base of the PR and between 567a2e2 and 06db940.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Addresses mosip/mosip-config#10670 — provides repository overview, tech stack,
build/test commands, and contribution notes for AI agents and
contributors working in this repo.

Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
Addresses mosip/mosip-config#10670 — extends the
existing root AGENTS.md into a tree, matching the pattern established on
mosip/id-repository and mosip/partner-management-services.

Adds:
- helm/AGENTS.md: Helm chart layout, install/restart/delete scripts, and
  agent rules for the Kubernetes deployment of the Compliance Toolkit UI.
- android/AGENTS.md: Capacitor-generated Android project layout, the real
  build sequence from .github/workflows/android.yml, and agent rules for
  keeping the native project in sync with capacitor.config.ts.

Root AGENTS.md is updated to act as a hub/index linking to both new guides.

Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@android/AGENTS.md`:
- Around line 45-49: Replace the concrete endpoint, realm, and client ID values
in the Android runtime configuration block with clearly marked placeholders or
generic documented examples. Preserve the required NX_APP variable names and
setup instructions, and avoid retaining the dev MOSIP URLs or credentials unless
they are explicitly approved backend configuration.

In `@helm/AGENTS.md`:
- Around line 52-54: Update the working-directory guidance in AGENTS.md so Helm
validation commands run from helm/ and reference compliance-toolkit-ui as the
chart path, matching the workflow’s CHARTS_DIR setting. Ensure all affected
command examples, including the additional referenced line, consistently use
this explicit directory context.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: fffce425-b2e4-48a7-bf21-dc395e55b7e7

📥 Commits

Reviewing files that changed from the base of the PR and between 06db940 and ce80024.

📒 Files selected for processing (3)
  • AGENTS.md
  • android/AGENTS.md
  • helm/AGENTS.md

Comment thread android/AGENTS.md Outdated
Comment thread helm/AGENTS.md Outdated
- android/AGENTS.md: use placeholders (with CI-default values noted in
  comments) instead of hardcoding MOSIP's shared dev environment as the
  literal setup values, to avoid readers pointing local builds at it
  unintentionally
- helm/AGENTS.md: clarify helm lint/template commands must run from
  helm/, not from inside helm/compliance-toolkit-ui/, matching CI's
  CHARTS_DIR; also fix a missing "Do not" that inverted the meaning of
  the secrets-in-git guidance

Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant